home *** CD-ROM | disk | FTP | other *** search
/ Revista CD Expert 8 / Revista CD Expert nº 08 CD1.iso / Utilitarios / Programacao / MS-DOS Interrupt List / inter60f / INT2WHLP.ZIP / I2W-CFG.TXT < prev    next >
Text File  |  1999-01-03  |  17KB  |  374 lines
  1. ; The INT2WHLP configuration file has sections and entries similar to
  2. ; Windows INI files.
  3. ; Sections have identifiers enclosed in brackets [], starting at the left
  4. ; margin. A section extends up to the next line starting with a left
  5. ; bracket [ at the left margin.
  6. ; Entries have identifiers starting at the left margin and extending up
  7. ; to an equal sign =. The value of an entry is the string or integer after
  8. ; the equal sign. INT2WHLP interprets digit 0 as boolean value false and
  9. ; any non-zero integer as boolean true when interpreted with the
  10. ; profileBoolean() procedure.
  11. ; Section and entry identifiers are not case sensitive, however spaces
  12. ; are significant caracters in identifiers. There may not be excessive
  13. ; spaces around the equal sign in entries (i.e. only spaces which are part
  14. ; of the identifier or value).
  15. ; A semicolon ; at the left margin identifies a comment.
  16.  
  17. ; In the following text enabled identifiers specify default program
  18. ; settings (unless otherwise noted), and commented-out identifiers are
  19. ; examples of valid values.
  20.  
  21. ; The FILES section specifies the pathes for the input and output files.
  22. ; These values can also be specified as program parameters, program
  23. ; parameters take precedence over values defined in the configuration
  24. ; file. The program will request values if neither program parameters,
  25. ; nor the configuration file, define values.
  26. [FILES]
  27. inPath=
  28. ; inPath=c:\interrup
  29. ; The input files are in directory C:\INTERRUP.
  30. outPath=
  31. ; outPath=.
  32. ; Pass the output files to the current directory.
  33.  
  34. ; The OPTIONS section specifies values which can also be set by program
  35. ; parameter options. Program paramter options take precedence over values
  36. ; specified in the configuration file.
  37. [OPTIONS]
  38. build=
  39. ; build=(WINENV | APP1) & TESTBUILD
  40. ; Copies the build expression to the HPJ file's [OPTIONS] section build=
  41. ; entry. See also the [BUILDTAGS] section. Program option -b. Note that
  42. ; the OR operator "|" cannot be passed as a program option, only the
  43. ; configuration file can pass the OR operator to the program.
  44. compression=none
  45. ; compression=medium
  46. ; compression=high
  47. ; Sets HC31 compression option. Program option -c.
  48. filterFile=
  49. ; filterFile=INTWIN.FLT
  50. ; Should be empty for a compilation of the entier Interrupt List, or define
  51. ; a filter file for a partial compilation. Program option -f.
  52. ; NOTE! It is recommended not to perform a partial compilation because
  53. ; references to tables may be missing.
  54. singlesInMain=0
  55. ; singlesInMain=1
  56. ; If 1, interrupt numbers with only one entry are inserted directly in the
  57. ; compressed index rather than a reference to a one-entry subindex, provided
  58. ; that the number of compressed index columns is set to 1. singlesInMain=1
  59. ; may be an advantage for a strongly filtered list. Program option -1.
  60. twoIndexes=1
  61. ; twoIndexes=0
  62. ; Enables or disables the expanded index. Program option -2.
  63. errorLog=0
  64. ; errorLog=1
  65. ; Disables or enables HC31's log file OutPath\INTWIN.ERR. Program option -e.
  66. headers=1
  67. ; headers=0
  68. ; If 1, insert a header for each new interrupt number in the expanded index.
  69. ; Program option -h.
  70. indexColumns=1
  71. ; indexColumns=4
  72. ; indexColumns=8
  73. ; indexColumns=16
  74. ; Specifies the number of columns in the compressed index. Program option -i.
  75. markKeys=1
  76. ; markKeys=0
  77. ; Controls whether or not keywords (like "See also:", "Notes:") are marked
  78. ; (bolded). The program compiles the List 20% faster, and HC31 yields a 1%
  79. ; shorter .HLP file when disabled, but the readability of the result is lower.
  80. ; Program option -m.
  81. longKeys=1
  82. ; longKeys=0
  83. ; Specifies whether both long and sort versions of interrupt search keys are
  84. ; used, or short versions only.
  85. ; Program option -l.
  86. ;keywordTable=
  87. keywordTable=T
  88. ; Specifies whether all keywords shall go to the primary keyword table in
  89. ; intwin.hlp, or table keywords #nnnn shal go to the TWBTREE table
  90. ; (paramter T). Other catagories may be included in future versions of
  91. ; INT2WHLP.
  92. ; Program option -k.
  93. equalBlanks=1
  94. ; equalBlanks=0
  95. ; Specifies whether or not spaces are inserted around the equal sign in
  96. ; register search strings, e.g. "INT 21 AH = 4C" or "INT 21 AH=4C". Program
  97. ; option -q.
  98. releaseNo=60
  99. ;releaseNo=41
  100. ; releaseNo=40
  101. ; Controls Interrupt List release number dependent behavior of INT2WHLP.
  102. ; Implemented influence:
  103. ;   releaseNo<41:  Tables are not treated as separate topics, no table cross
  104. ;           references.
  105. ; Program option -r
  106. scrollIndexTitle=1
  107. ; scrollIndexTitle=0
  108. ; Index windows have a general header and a title. If scrollIndexTitle=1,
  109. ; the title scrolls with the rest of the index window, otherwise the title
  110. ; is part of the non-scrolling header region. Program option -s.
  111. tableWindow=1
  112. ; tableWindow=0
  113. ; If 1, tables referenced from text (with a #nnnn hotspot) appear in
  114. ; a secodary window. The table can be copied to the main window with a
  115. ; "Copy to main" hotspot included in all tables.
  116. ; If 0, tables appear in the main window.
  117. ; Program option -t
  118. expandedIndex=1
  119. ; expandedIndex=0
  120. ; 1 or 0 causes the Interrupt List Index initially to pop up in expanded (all
  121. ; entries in one window) or in compressed (index with subindexes) format.
  122. ; Program option -x
  123.  
  124.  
  125. ; The CONFIG section defines WINHELP setups and defaults.
  126. [CONFIG]
  127. pos and size=
  128. ; pos and size=(0,0,980,1023)
  129. ; Defines the position and size of the initial main window. The format is
  130. ; (xpos,ypos,width,height) and valid values are 0..1023, defining 1024th
  131. ; of the screen witdh and hight. xpos+width and ypos+hight may not exceed
  132. ; 1023.
  133. secondary pos and size=(43,0,980,1023)
  134. ; secondary pos and size=(243,0,780,850)
  135. ; Defines the position and size of the secondary window. The format is the
  136. ; same as for "pos and size". The initial size of a secondary window MUST
  137. ; be defined. Users of large, high resolution screens may prefer the choice
  138. ; that is disabled above.
  139. ; The entry is ignored if secondary table windows are disabled.
  140. background=
  141. ; background=(255,255,255)
  142. ; Defines the background color of the normal text window in the format
  143. ; (red,green,blue). Valid values are 0..255. (255,255,255) defines a
  144. ; white background color.
  145. header background=
  146. ; header background=(255,255,192)
  147. ; Defines the background color of the non-scrolling part of the windows.
  148. ; (255,255,192) defines a light yellow color.
  149. text font=modern Courier New
  150. ; Defines the font used for the plain text. Due to the tables in the
  151. ; Interrupt List, this should be a fixed pitch font, and because it should
  152. ; be a TrueType font to take advantage of the font sizing, Windows 3.1
  153. ; has no alternatives. "modern" is the font family (modern=fixed pitch,
  154. ; roman=proportionally spaced serif, swiss=proportionally spaced sans serif),
  155. ; and "Courier New" is the font name.
  156. ; If point size 10 or 12 (see deciPoints) is used, the bitmapped font
  157. ; "modern Courier" can be used, though.
  158. header font=roman Times New Roman
  159. ; header font=swiss Arial
  160. ; Font used for headers.
  161. deciPoints=90
  162. ; deciPoints=95
  163. ; deciPoints=100
  164. ; deciPoints=120
  165. ; 10 times the font point size. A 9 point font can be displayed on a
  166. ; standard VGA screen without the need of horizontal scroll. The point
  167. ; size is not true typographical point size, it varies with screen
  168. ; resolution and size, and a larger point size is preferable for a high
  169. ; resolution screen with small dimensions. HC31 assigns size in half-points,
  170. ; corresponding to deciPoints increments of 5.
  171. header deciPoints=140
  172. header 2nd deciPoints=120
  173. ; Two font sizes used in the headers.
  174.  
  175. ; The INTWINCONFIG section is optional and is not used for program generated
  176. ; output. Entries in the section are copied to the help project file's
  177. ; [CONFIG] section. It can be used to insert macros in the final help file.
  178. ;[INTWINCONFIG]
  179. ;InsertItem("mnu_help","mnu_h","&INTWIN Help","JI(`',`idHelp')",0)
  180.  
  181. ; The WINDOWS section defines the number of extra "windows" included in
  182. ; the compilation in addition to the Interrupt List.
  183. [WINDOWS]
  184. number=4
  185. ; Number of additional windows (5 are defined, but only 4 enabled).
  186. ; NB! number=0 is the program default, and the following windows are not
  187. ; defined by default.
  188.  
  189. ; For each window defined by the [WINDOWS] number=n entry, there must be
  190. ; a section [WINDOW 1], ... [WINDOW 9], [WINDOW 10], ... [WINDOW n] with
  191. ; 3 obligatory entries and some optional entries.
  192. [WINDOW 1]
  193. title=Ports
  194. id=idPorts
  195. ; title and id are obligatory entries defining the topic title and
  196. ; identifier (context string). [WINDOW i] sections with an empty title=
  197. ; or id= entry are ignored, and a warning is printed on the screen.
  198. ; See comment "Help windows topic titles and identifiers" in INT2WHLP.INC
  199. ; for reserved identifiers.
  200. type=2
  201. ; There are 3 window types: type=1 are single entry windows referenced
  202. ; directly from the main index. type=1 is the default type. type=2 are
  203. ; windows with their own index, which is referenced from the main index.
  204. ; The differences between type=1 and type=2 are the browse chain linkage
  205. ; and the default "file n type=" value. type=3 defines a window with at
  206. ; least one RTF file defining the window properties. The RTF file must
  207. ; have a topic with the identifier (context string) defined by id=, and
  208. ; that topic should have a title defined by title= and contain an index
  209. ; for the system.
  210. ; files=1
  211. ; The entry files= defines the number of files included in the current
  212. ; window. Only type=3 windows can have more than one file, and files=1 is
  213. ; the default value.
  214. file 1=ports
  215. ; For each file i = 1..n defined by the files=n entry (normally only 1)
  216. ; there must be a file i=<file name> entry specifying a file. See a later
  217. ; paragraph about default directories and extensions.
  218. ;
  219. ; file 1 type=2
  220. ; There are 4 file types: file i type=1 are files passed to the program's
  221. ; ProcessFile() procedure. file i type=2 are files passed to the program's
  222. ; ProcessPort() procedure. file i type=3 are RTF files defining their own
  223. ; and other included files' properties. file i type=4 are files assigned
  224. ; their own titles and identifiers (context strings). type=4 files are
  225. ; passed to the program's ProcessFile() procedure, and they should be
  226. ; referenced from an RTF file.
  227. ; The default file i type= value is the window's type= value.
  228. ; Files' default directories depend on the file types. File types 1 and 2
  229. ; are typically files included in the Interrupt List: PORTS.LST, MEMORY.LST
  230. ; etc. Therefore, the default directory for file types 1 and 2 is the
  231. ; InPath directory. File type 3 are typically the user's own file or one
  232. ; of the RTF files supplied in this package, so the default directory
  233. ; is 1) the current directory or 2) INT2WHLP's home directory. File type
  234. ; 4 are the users own files, and the default directory is the current
  235. ; directory.
  236. ; In all cases the full path (a path including a drive, the root, or the
  237. ; current or parent directory . or ..) can be specified to override the
  238. ; default directory.
  239. ; Type 2 files' default extension is .LST or, if .LST is not found, .A, .B,
  240. ; etc.. The first two lines in file .B and successive files are ignered. To
  241. ; compile a file without an extension include the extension dot, e.g.
  242. ; file 1=myfile., or rename the file.
  243. ;
  244. ; file i title=<title>
  245. ; file i id=<id>
  246. ; file i chain=<browse chain>
  247. ; Type 4 files have titles, identifiers, and browse chain definitions.
  248. ; The default values are "<window title> - i", "<window id>_i", and
  249. ; "<window id>:5" where i is the current file number. The empty value is
  250. ; legal for file i chain= and causes the file to be excluded from any
  251. ; browse chain.
  252. ; See comment "Help windows topic titles and identifiers" in INT2WHLP.INC
  253. ; for implemented browse chains.
  254.  
  255. [WINDOW 2]
  256. title=Memory
  257. id=idMemory
  258. ; type=1 is the default window type
  259. ; files=1 is the default number of files
  260. file 1=memory.lst
  261. ; file 1 type=1 is the default type because the window type is 1.
  262.  
  263. [WINDOW 3]
  264. title=CPU
  265. id=idCPU
  266. file 1=86bugs.lst
  267.  
  268. [WINDOW 4]
  269. title=CMOS
  270. id=idCMOS
  271. type=1
  272. file 1=cmos.lst
  273.  
  274. ;[WINDOW 5]
  275. ;   (This part is disabled due to aliases required by the assosiated file)
  276. ;title=Miscellaneous Information
  277. ;id=MISC_INF_0
  278. ;type=3
  279. ; type=3 specifies a window with its own definition in an RTF file.
  280. ; MISC_INF_0 is the identifier (context string) for one of the topics in
  281. ; the RTF file. That topic is normally an index for other topics in the
  282. ; file.
  283. ;
  284. ; files=1 is the default number of files
  285. ;file 1=misc_inf.rtf
  286. ;   (misc_inf.rtf references context strings that should be defined in the
  287. ;    ALIAS part of the configuration file)
  288. ; file 1 type=3 is the default type because the window type is 3. It
  289. ; specifies an RTF file.
  290.  
  291. ; The ALIAS section is optional and is not used for program generated
  292. ; output. It compiles an ALIAS list to the HPJ file. Two of the RTF files
  293. ; supplied in this pasckage (SEL_TOPC.RTF and MISC_INF.RTF) require
  294. ; some aliases.
  295. ; [ALIAS]
  296. ; id87err=INT 10 ---- - CPU-generated (80286+) - COPROCESSOR ERROR
  297. ; idVideo_00=INT 10 00-- - VIDEO - SET VIDEO MODE
  298. ; idVideo_1013=INT 10 1013 - VIDEO - SELECT VIDEO DAC COLOR PAGE (VGA)
  299. ; Each entry is of the form
  300. ;   id=<modified INT header>
  301. ; where id is a user defined identifier (context string) no longer than 18
  302. ; characters, and <modified INT header> is an INT header with flags removed
  303. ; from char. pos. 9+ (i.e. if char. 9 is not "-" then delete up to, but not
  304. ; including, a "-" character), and with a register value (from the divider
  305. ; line char. pos. 13-16) + a space inserted at char. pos. 8-12, as shown in
  306. ; the example. The program substitutes the actual identifier (context string)
  307. ; for the <modified INT header> and copies the id=actual_id part to an
  308. ; [ALIAS] section in the HPJ file. The example would result in an HPJ
  309. ; section (based on Interrupt List release 40):
  310. ;
  311. ; [ALIAS]
  312. ; id87err=10_1
  313. ; idVideo_00=10_2
  314. ; idVideo_1013=10_46
  315. ;
  316. ; The entries must appear in the same order as the <modified INT header>
  317. ; appear in the Interrupt List. The program can assign more than one user
  318. ; defined id to the same interrupt entry in the list, the entries must of
  319. ; course be consecutive and have identical <modified INT header> values.
  320. ;
  321. ; Empty lines and lines starting with a semicolon (;) are ignored.
  322.  
  323. ; Also the TABLEALIAS section is optional and compiles an ALIAS list to the
  324. ; HPJ file. SEL_TOPC.RTF require some tabel aliases.
  325. ; [TABLEALIAS]
  326. ; idListList=21 52-- Format of List of Lists:
  327. ; Each entry is of the form
  328. ;   id=II FUNC <title>
  329. ; where id is a user defined identifier (context string) no longer than 18
  330. ; characters, II is a two digit hexadecimal number and FUNC is four characters
  331. ; describing the subfunction where the table is located. II and FUNC are also
  332. ; characters 11-12 and 13-16 of the previous divider line. <title> is the
  333. ; table's title. The program substitutes the actual identifier (context
  334. ; string) for the II FUNC <title> part and copies the id=actual_id part to
  335. ; an [ALIAS] section in the HPJ file, mixed with the output from an [AIAS]
  336. ; section in the configuration file. The example would insert in an HPJ
  337. ; [ALIAS] section an entry like (depending on Interrupt List release):
  338. ;
  339. ; idListList=t0724
  340. ;
  341. ; The entries must appear in the same order as the tables appear in the
  342. ; Interrupt List. The program can assign more than one user defined id to
  343. ; the same table.
  344. ;
  345. ; Empty lines and lines starting with a semicolon (;) are ignored.
  346.  
  347. ; The INTWINCONFIG section is optional and is not used for program generated
  348. ; output. It is included to facilitate copying macros to the [CONFIG]
  349. ; section in the Help Project File.
  350. ; [INTWINCONFIG]
  351. ; InsertItem("mnu_help","mnu_hlp","&INTWIN Help","JI(`',`idHelp')",0)
  352.  
  353. ; The BUILDTAGS section is optional and is not used for program generated
  354. ; output. It is included to support users' RTF files with conditional
  355. ; build. If the user's RTF files have build tags ("*" footnotes), the tags
  356. ; must be defined in a BUILDTAGS section in the configuration file.
  357. ; [BUILDTAGS]
  358. ; WINENV
  359. ; APP1
  360. ; TESTBUILD
  361. ;
  362. ; The BUILGTAGS section is simply copied to the HPJ file, ignoring empty
  363. ; lines and lines starting with a semicolon (;).
  364. ;
  365. ; See also the [OPTIONS] section's build= entry.
  366.  
  367. ; The BAGGAGE section is optional and is not used for program generated
  368. ; output. It is included to support inclusion of baggage in the help file.
  369. ; [BAGGAGE]
  370. ; BAG.INI
  371. ;
  372. ; The BAGGAGE section is simply copied to the HPJ file, ignoring empty
  373. ; lines and lines starting with a semicolon (;).
  374.